/*
 * Copyright 2013-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.cloud.gateway.filter;

import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

import reactor.core.publisher.Mono;

import org.springframework.cloud.gateway.event.EnableBodyCachingEvent;
import org.springframework.cloud.gateway.route.Route;
import org.springframework.cloud.gateway.support.ServerWebExchangeUtils;
import org.springframework.context.ApplicationListener;
import org.springframework.core.Ordered;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.web.server.ServerWebExchange;

import static org.springframework.cloud.gateway.support.ServerWebExchangeUtils.CACHED_REQUEST_BODY_ATTR;
import static org.springframework.cloud.gateway.support.ServerWebExchangeUtils.CACHED_SERVER_HTTP_REQUEST_DECORATOR_ATTR;
import static org.springframework.cloud.gateway.support.ServerWebExchangeUtils.GATEWAY_ROUTE_ATTR;

/**
 * 类概述
 * AdaptCachedBodyGlobalFilter 是一个实现了 GlobalFilter, Ordered, 和 ApplicationListener<EnableBodyCachingEvent> 接口的类。
 * 它的主要功能是处理请求体缓存相关的逻辑，
 * 确保在网关中对某些路由的请求体进行缓存，
 * 并在需要时重新使用这些缓存的请求体。
 *
 * 应用场景
 * 	请求体多次读取:
 * 		在网关中，某些过滤器可能需要多次读取请求体（如鉴权、日志记录等）。为了避免请求体被消耗后无法再次读取，可以通过缓存机制解决。
 * 	性能优化:
 * 		对于某些高频访问的路由，缓存请求体可以减少重复读取和解析的开销。
 * 	动态路由管理:
 * 		通过事件监听机制动态控制哪些路由需要启用请求体缓存，提升灵活性。
 */
public class AdaptCachedBodyGlobalFilter implements GlobalFilter, Ordered, ApplicationListener<EnableBodyCachingEvent> {

	/**
	 * 功能: routesToCache 是一个线程安全的哈希表，用于存储需要缓存请求体的路由。
	 * 键 (String)：路由 ID。
	 * 值 (Boolean)：是否启用缓存（这里固定为 true）。
	 * 作用: 通过事件监听机制动态添加需要缓存请求体的路由。
	 */
	private ConcurrentMap<String, Boolean> routesToCache = new ConcurrentHashMap<>();

	@Override
	public void onApplicationEvent(EnableBodyCachingEvent event) {
		this.routesToCache.putIfAbsent(event.getRouteId(), true);
	}

	@Override
	public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
		// the cached ServerHttpRequest is used when the ServerWebExchange can not be
		// mutated, for example, during a predicate where the body is read, but still
		// needs to be cached.

		//如果 exchange 的属性中已经存在缓存的 ServerHttpRequest 对象（cachedRequest），则直接移除该属性并使用该缓存的请求对象继续处理链。
		//这是为了避免在某些情况下（如断言中读取了请求体）导致请求不可变的问题。
		ServerHttpRequest cachedRequest = exchange.getAttributeOrDefault(CACHED_SERVER_HTTP_REQUEST_DECORATOR_ATTR,
				null);
		if (cachedRequest != null) {
			exchange.getAttributes().remove(CACHED_SERVER_HTTP_REQUEST_DECORATOR_ATTR);
			return chain.filter(exchange.mutate().request(cachedRequest).build());
		}


		DataBuffer body = exchange.getAttributeOrDefault(CACHED_REQUEST_BODY_ATTR, null);
		Route route = exchange.getAttribute(GATEWAY_ROUTE_ATTR);

		//如果请求体已经被缓存（body != null），或者当前路由不在需要缓存的路由列表中，则直接跳过缓存逻辑，继续处理链。
		if (body != null || !this.routesToCache.containsKey(route.getId())) {
			return chain.filter(exchange);
		}

		//调用 ServerWebExchangeUtils.cacheRequestBody 方法缓存请求体。
		//缓存完成后，通过回调函数判断是否需要重新构建请求对象：
		//如果新的请求对象与原始请求对象相同，则直接继续处理链。
		//否则，使用 exchange.mutate() 方法重新构建一个新的 ServerWebExchange 对象，并继续处理链。
		//作用: 确保在网关中对指定路由的请求体进行缓存，并在需要时重新使用这些缓存的请求体。

		return ServerWebExchangeUtils.cacheRequestBody(exchange, (serverHttpRequest) -> {
			// don't mutate and build if same request object
			if (serverHttpRequest == exchange.getRequest()) {
				return chain.filter(exchange);
			}
			return chain.filter(exchange.mutate().request(serverHttpRequest).build());
		});
	}

	@Override
	public int getOrder() {
		return Ordered.HIGHEST_PRECEDENCE + 1000;
	}

}
